Search-IMAsset

SYNOPSIS

Searches assets using AI content analysis.

SYNTAX

Search-IMAsset [[-Session] <ImmichSession>] [[-City] <String>] [[-Country] <String>]
 [[-CreatedAfter] <DateTime>] [[-CreatedBefore] <DateTime>] [[-DeviceId] <String>] [[-Visibility] <String>]
 [[-OCR] <String>] [[-IsEncoded] <Boolean>] [[-IsFavorite] <Boolean>] [[-IsMotion] <Boolean>]
 [[-IsNotInAlbum] <Boolean>] [[-IsOffline] <Boolean>] [[-LensModel] <String>] [[-LibraryId] <String>]
 [[-AlbumIds] <String[]>] [[-Make] <String>] [[-Model] <String>] [[-Language] <String>]
 [[-PersonIds] <String[]>] [-Query] <String> [[-Rating] <Int32>] [[-Size] <Int32>] [[-State] <String>]
 [[-TagIds] <String[]>] [[-TakenAfter] <DateTime>] [[-TakenBefore] <DateTime>] [[-TrashedAfter] <DateTime>]
 [[-TrashedBefore] <DateTime>] [[-Type] <String>] [[-UpdatedAfter] <DateTime>] [[-UpdatedBefore] <DateTime>]
 [[-WithDeleted] <Boolean>] [[-WithEXIF] <Boolean>] [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

Uses machine learning to find assets by visual content, faces, objects, and OCR text. Results may vary based on model accuracy. For metadata searches, use Find-IMAsset.

EXAMPLES

EXAMPLE 1

Search-IMAsset -Query 'Road'

Searches for assets matching content Road.

EXAMPLE 2

Search-IMAsset -OCR 'birthday party'

Finds photos containing 'birthday party' text.

PARAMETERS

-Session

Optional session object for multi-instance connections.

Type: ImmichSession
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-City

Filter by city name.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Country

Filter by country name.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-CreatedAfter

Include assets created after this date.

Type: DateTime
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-CreatedBefore

Include assets created before this date.

Type: DateTime
Parameter Sets: (All)
Aliases:

Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-DeviceId

Filter by device identifier.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Visibility

Asset visibility: archive, timeline, hidden, or locked.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-OCR

Search text extracted from images via OCR.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 8
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-IsEncoded

Filter by video encoding status.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 9
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-IsFavorite

Favorite filter

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 10
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-IsMotion

Motion filter

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 11
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-IsNotInAlbum

Not in Album filter

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 12
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-IsOffline

Offline filter

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 13
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-LensModel

Lens model filter

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 14
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-LibraryId

Library id filter

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 15
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-AlbumIds

Album id filter (array of UUIDs)

Type: String[]
Parameter Sets: (All)
Aliases:

Required: False
Position: 16
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Make

Make filter

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 17
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Model

Model filter

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 18
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Language

Language filter

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 19
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PersonIds

Person id filter

Type: String[]
Parameter Sets: (All)
Aliases:

Required: False
Position: 20
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Query

Query filter

Type: String
Parameter Sets: (All)
Aliases: SearchString

Required: True
Position: 21
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Rating

Rating filter

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 22
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-Size

Size of rest call page

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 23
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-State

State filter

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 24
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-TagIds

Tag id filter

Type: String[]
Parameter Sets: (All)
Aliases:

Required: False
Position: 25
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-TakenAfter

Taken after filter

Type: DateTime
Parameter Sets: (All)
Aliases:

Required: False
Position: 26
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-TakenBefore

Taken before filter

Type: DateTime
Parameter Sets: (All)
Aliases:

Required: False
Position: 27
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-TrashedAfter

Trashed after filter

Type: DateTime
Parameter Sets: (All)
Aliases:

Required: False
Position: 28
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-TrashedBefore

Trashed before filter

Type: DateTime
Parameter Sets: (All)
Aliases:

Required: False
Position: 29
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Type

Type filter

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 30
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-UpdatedAfter

Updated after filter

Type: DateTime
Parameter Sets: (All)
Aliases:

Required: False
Position: 31
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-UpdatedBefore

Updated before filter

Type: DateTime
Parameter Sets: (All)
Aliases:

Required: False
Position: 32
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WithDeleted

Deleted filter

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 33
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-WithEXIF

Exif filter

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 34
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

Requires machine learning models to be enabled and trained.

RELATED LINKS

EDIT THIS DOC

This page was auto-generated from the powershell command comment based help. To edit the content of this page, update the script file comment based help on github Github